FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.uv.cardx-htn-mng#current (46 ms)

Package hl7.fhir.uv.cardx-htn-mng
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/uv/cardx-htn-mng/https://build.fhir.org/ig/HL7/CardX-HTN-MNG/CapabilityStatement-CardXCapabilityStatementServer.html
Url http://hl7.org/fhir/uv/cardx-htn-mng/CapabilityStatement/CardXCapabilityStatementServer
Version 1.0.0
Status draft
Date 2023-12-05
Name CardXHTNServerCapabilityStatement
Title HTN-Mng-CardX Server Capability Statement
Experimental False
Realm uv
Authority hl7
Description The capabilities that a CardX Hypertension Management server system should/shall support.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
average-smbp Average Self-measured Blood Pressure
self-measured-bp Self-measured Blood Pressure
smbp-associated-heart-rate SMBP Associated Heart Rate


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement CardXCapabilityStatementServer

HTN-Mng-CardX Server Capability Statement

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2023-12-05
  • Published by: HL7 International / Clinical Interoperability Council

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

A CardX Hypertension Management Patient Management Server SHALL:

  1. Support the Observation resource.

  2. Self-measured Blood Pressure Profile.

  3. Support the Average Self-measured Blood Pressure profile.

  4. Support json and xml source formats for all CardX interactions.

  5. Support searches by Observation.category.

  6. Support create capabilites for the IG profiles.

A CardX Hypertension Management Server SHOULD:

  1. Support the Self-measured Blood Pressure Associated Heart Rate profile.
  2. Support searches by Observation.patient.
Security
  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.
Summary of System-wide Interactions
  • Supports the history-systeminteraction described as follows:

    A CardX Hypertension Management Server SHALL:

    1. Support read operations.
    2. Support search-type operations.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patient 
ObservationSupported Profiles
  Self-measured Blood Pressure
  Average Self-measured Blood Pressure
  SMBP Associated Heart Rate
yyyidentifier, category

Resource Conformance: SHOULD Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

    Resource Conformance: SHALL Observation

    Core FHIR Resource
    Observation
    Reference Policy
    Interaction summary
    • SHALL support create, read, search-type.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLcategorytoken
    SHOULDidentifierreference
     

    Source

    {
      "resourceType" : "CapabilityStatement",
      "id" : "CardXCapabilityStatementServer",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement CardXCapabilityStatementServer</b></p><a name=\"CardXCapabilityStatementServer\"> </a><a name=\"hcCardXCapabilityStatementServer\"> </a><a name=\"CardXCapabilityStatementServer-en-US\"> </a><h2 id=\"title\">HTN-Mng-CardX Server Capability Statement</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2023-12-05 </li><li>Published by: HL7 International / Clinical Interoperability Council </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>A CardX Hypertension Management Patient Management Server <strong>SHALL</strong>:</p>\n<ol>\n<li>\n<p>Support the Observation resource.</p>\n</li>\n<li>\n<p>Self-measured Blood Pressure Profile.</p>\n</li>\n<li>\n<p>Support the Average Self-measured Blood Pressure profile.</p>\n</li>\n<li>\n<p>Support json and xml source formats for all CardX interactions.</p>\n</li>\n<li>\n<p>Support searches by Observation.category.</p>\n</li>\n<li>\n<p>Support create capabilites for the IG profiles.</p>\n</li>\n</ol>\n<p>A CardX Hypertension Management Server <strong>SHOULD</strong>:</p>\n<ol>\n<li>Support the Self-measured Blood Pressure Associated Heart Rate profile.</li>\n<li>Support searches by Observation.patient.</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<li>See the <a href=\"https://www.hl7.org/fhir/security.html#general\">General Security Considerations</a> section for requirements and recommendations.</li>\n<li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li>\n</ol>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>history-system</code>interaction described as follows:<div><p>A CardX Hypertension Management Server <strong>SHALL</strong>:</p>\n<ol>\n<li>Support read operations.</li>\n<li>Support search-type operations.</li>\n</ol>\n</div></li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Patient1-1\">Patient</a></td><td>�</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-2\">Observation</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-self-measured-bp.html\">Self-measured Blood Pressure</a><br/>��<a href=\"StructureDefinition-average-smbp.html\">Average Self-measured Blood Pressure</a><br/>��<a href=\"StructureDefinition-smbp-associated-heart-rate.html\">SMBP Associated Heart Rate</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td>identifier, category</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul/></div></div><p/><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Observation1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Observation</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>create</code>, <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-self-measured-bp.html\">Self-measured Blood Pressure</a><br/><a href=\"StructureDefinition-average-smbp.html\">Average Self-measured Blood Pressure</a><br/><a href=\"StructureDefinition-smbp-associated-heart-rate.html\">SMBP Associated Heart Rate</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">identifier</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "cic"
        }
      ],
      "url" : "http://hl7.org/fhir/uv/cardx-htn-mng/CapabilityStatement/CardXCapabilityStatementServer",
      "version" : "1.0.0",
      "name" : "CardXHTNServerCapabilityStatement",
      "title" : "HTN-Mng-CardX Server Capability Statement",
      "status" : "draft",
      "date" : "2023-12-05",
      "publisher" : "HL7 International / Clinical Interoperability Council",
      "contact" : [
        {
          "name" : "HL7 International / Clinical Interoperability Council",
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/cic"
            },
            {
              "system" : "email",
              "value" : "ciclist@lists.hl7.org"
            }
          ]
        }
      ],
      "description" : "The capabilities that a CardX Hypertension Management server system should/shall support.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
              "code" : "001",
              "display" : "World"
            }
          ]
        }
      ],
      "kind" : "requirements",
      "fhirVersion" : "4.0.1",
      "format" : [
        "xml",
        "json"
      ],
      "rest" : [
        {
          "mode" : "server",
          "documentation" : "A CardX Hypertension Management Patient Management Server **SHALL**:\n\n1. Support the Observation resource.\n\n1. Self-measured Blood Pressure Profile. \n1. Support the Average Self-measured Blood Pressure profile.\n1. Support json and xml source formats for all CardX interactions. \n1. Support searches by Observation.category.\n\n1. Support create capabilites for the IG profiles. \n\n\nA CardX Hypertension Management Server **SHOULD**:\n\n1. Support the Self-measured Blood Pressure Associated Heart Rate profile.\n1. Support searches by Observation.patient.\n\n\n",
          "security" : {
            "description" : "1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
          },
          "resource" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "type" : "Patient"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "type" : "Observation",
              "supportedProfile" : [
                "http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/self-measured-bp",
                "http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/average-smbp",
                "http://hl7.org/fhir/uv/cardx-htn-mng/StructureDefinition/smbp-associated-heart-rate"
              ],
              "_supportedProfile" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ]
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ]
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ]
                }
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "create"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "search-type"
                }
              ],
              "searchParam" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "name" : "identifier",
                  "definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
                  "type" : "reference"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "category",
                  "definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
                  "type" : "token"
                }
              ]
            }
          ],
          "interaction" : [
            {
              "code" : "history-system",
              "documentation" : "A CardX Hypertension Management Server **SHALL**:\n\n1. Support read operations. \n1. Support search-type operations. \n\n"
            }
          ]
        }
      ]
    }

    XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.